All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface quicktime.app.display.QTDisplaySpace

public interface QTDisplaySpace

extends QTDrawable, Space

As a display space is by definition a collection of objects that have some kind of visual appearance, the display space must manage (or its contained objects) the layering of those objects within the visual presentation of the space. As such, this interface provides an API for retrieving the current front and back most layers of its members, and a way of retrieving the Layerable object for a member that allow the member to both get and set its Layer within the display space. Also a member can be added to the display space specifying the layer at which it should be added. The lower a layer (or z) value the more frontmost the object is displayed at. The backmost layer of a QTDisplaySpace is Short.MAX_VALUE.

Members of display spaces may or may not know about their position and two Dimensional display matrix. As such the QTDisplaySpace also provides an API for retrieving a member's Transformable interface that allows a member to get and set its display matrix.

See Also:

Transformable, Layerable

addMember(Object, int)

Adds a member to the QTDisplaySpace at the specified layer.

getBackLayer()

Returns the layer of the backmost member in the display space.

getFrontLayer()

Returns the layer of the frontmost member in the display space.

getLayerable(Object)

Returns the Layerable object for a member (or null if the Object is not a member) that allows the application to get and set the layer of a member.

getTransformable(Object)

Returns the Transformable object that represents the member in the DisplaySpace.

 public abstract int getFrontLayer() throws QTException

Returns the layer of the frontmost member in the display space.

Returns:

an int

 public abstract int getBackLayer() throws QTException

Returns the layer of the backmost member in the display space.

Returns:

an int

 public abstract Layerable getLayerable(Object member)

Returns the Layerable object for a member (or null if the Object is not a member) that allows the application to get and set the layer of a member. This may or may not be the member itself, depending both on the type of the object of the member and the manner in which the QTDisplaySpace handles the Layer property of its members.

Parameters:

member - the member

Returns:

a Layerable object to interact with the display layer of a member.

 public abstract Transformable getTransformable(Object member)

Returns the Transformable object that represents the member in the DisplaySpace. The Transformable object allows the application to get and set the TwoD display characteristics of a member (position, size, rotation, skewing, perspective). If the Object is not a member of the Space this returns null. This may or may not return the member itself, based on the type of the member and how the Space deals with the two dimensional placement and display of its members.

Parameters:

member - the member of Space for which the Transformable object should be returned.

Returns:

a Transformable object that allows the application to manipulate the two d display characteristics of the member or null if the object is not a member.

 public abstract boolean addMember(Object member,
                                   int layer) throws QTException

Adds a member to the QTDisplaySpace at the specified layer. If the member is not an appropriate type of object for the Space this method returns false and the member is not added.

Parameters:

member - the member to add to the Display Space

layer - the layer of the member when added.

Returns:

true if the member was appropriate and was added to the space, otherwise false

All Packages  Class Hierarchy  This Package  Previous  Next  Index